<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
    <title>DB_ENV-&gt;rep_set_timeout()</title>
    <link rel="stylesheet" href="apiReference.css" type="text/css" />
    <meta name="generator" content="DocBook XSL Stylesheets V1.73.2" />
    <link rel="start" href="index.html" title="Berkeley DB C API Reference" />
    <link rel="up" href="rep.html" title="Chapter 10.  Replication Methods" />
    <link rel="prev" href="repset_request.html" title="DB_ENV-&gt;rep_set_request()" />
    <link rel="next" href="reptransport.html" title="DB_ENV-&gt;rep_set_transport()" />
  </head>
  <body>
    <div xmlns="" class="navheader">
      <div class="libver">
        <p>Library Version 11.2.5.3</p>
      </div>
      <table width="100%" summary="Navigation header">
        <tr>
          <th colspan="3" align="center">DB_ENV-&gt;rep_set_timeout()</th>
        </tr>
        <tr>
          <td width="20%" align="left"><a accesskey="p" href="repset_request.html">Prev</a> </td>
          <th width="60%" align="center">Chapter 10. 
                Replication Methods
        </th>
          <td width="20%" align="right"> <a accesskey="n" href="reptransport.html">Next</a></td>
        </tr>
      </table>
      <hr />
    </div>
    <div class="sect1" lang="en" xml:lang="en">
      <div class="titlepage">
        <div>
          <div>
            <h2 class="title" style="clear: both"><a id="repset_timeout"></a>DB_ENV-&gt;rep_set_timeout()</h2>
          </div>
        </div>
      </div>
      <pre class="programlisting">#include &lt;db.h&gt;

int
DB_ENV-&gt;rep_set_timeout(DB_ENV *env, int which, u_int32_t timeout);  </pre>
      <p>
         The <code class="methodname">DB_ENV-&gt;rep_set_timeout()</code> method
         specifies a variety of replication timeout values.
    </p>
      <p>
         The database environment's replication subsystem may also be
         configured using the environment's <a href="../../programmer_reference/env_db_config.html#env_db_config.DB_CONFIG" class="olink">DB_CONFIG</a> file.  The syntax
         of the entry in that file is a single line with the string
         "rep_set_timeout", one or more whitespace characters, and the
         <span class="bold"><strong>which</strong></span> parameter specified as a
         string and the timeout specified as two parts. For example,
         "rep_set_timeout DB_REP_CONNECTION_RETRY 15000000"  specifies the
         connection retry timeout for 15 seconds.  Because the <a href="../../programmer_reference/env_db_config.html#env_db_config.DB_CONFIG" class="olink">DB_CONFIG</a>
         file is read when the database environment is opened, it will
         silently overrule configuration done before that time.
    </p>
      <p>
         The <code class="methodname">DB_ENV-&gt;rep_set_timeout()</code> method
         configures a database environment, not only operations performed
         using the specified <a class="link" href="env.html" title="Chapter 5.  The DB_ENV Handle">DB_ENV</a>
         handle.
    </p>
      <p>
        The <code class="methodname">DB_ENV-&gt;rep_set_timeout()</code> method may not be
        called to set the master lease timeout after the 
        <a class="xref" href="repmgrstart.html" title="DB_ENV-&gt;repmgr_start()">DB_ENV-&gt;repmgr_start()</a> method or the
        <a class="xref" href="repstart.html" title="DB_ENV-&gt;rep_start()">DB_ENV-&gt;rep_start()</a> 
        method is called. For all other timeouts, the
        <code class="methodname">DB_ENV-&gt;rep_set_timeout()</code>
        method may be called at any time during the life of the application.
    </p>
      <p>
         The <code class="methodname">DB_ENV-&gt;rep_set_timeout()</code> <span>
            <span>
                  method returns a non-zero error value on failure and 0 on success.
            </span>
            
        </span>
    </p>
      <div class="sect2" lang="en" xml:lang="en">
        <div class="titlepage">
          <div>
            <div>
              <h3 class="title"><a id="idp54187968"></a>Parameters</h3>
            </div>
          </div>
        </div>
        <div class="sect3" lang="en" xml:lang="en">
          <div class="titlepage">
            <div>
              <div>
                <h4 class="title"><a id="idp54188440"></a>timeout</h4>
              </div>
            </div>
          </div>
          <p>
                The <span class="bold"><strong>timeout</strong></span> parameter is the timeout value. It
                must be specified as an unsigned 32-bit number of microseconds, limiting the
                maximum timeout to roughly 71 minutes.
            </p>
        </div>
        <div class="sect3" lang="en" xml:lang="en">
          <div class="titlepage">
            <div>
              <div>
                <h4 class="title"><a id="idp54158080"></a>which</h4>
              </div>
            </div>
          </div>
          <p>
                The <span class="bold"><strong>which</strong></span> parameter must
                be set to one of the following values:
             </p>
          <div class="itemizedlist">
            <ul type="disc">
              <li>
                <p><a id="set_timeout_DB_REP_ACK_TIMEOUT"></a>
                          <code class="literal">DB_REP_ACK_TIMEOUT</code>
                     </p>
                <p>
                         Configure the amount of time the Replication
                         Manager's transport function waits to collect
                         enough acknowledgments from replication group
                         clients, before giving up and returning a failure
                         indication.  The default wait time is 1 second.
                    </p>
              </li>
              <li>
                <p>
                          <code class="literal">DB_REP_CHECKPOINT_DELAY</code>
                     </p>
                <p>
                         Configure the amount of time a master site will
                         delay between completing a checkpoint and writing
                         a checkpoint record into the log.  This delay
                         allows clients to complete their own checkpoints
                         before the master requires completion of them.
                         The default is 30 seconds. If all databases in the
                         environment, and the environment's transaction
                         log, are configured to reside in memory (never
                         preserved to disk), then, although checkpoints are
                         still necessary, the delay is not useful and
                         should be set to 0.
                    </p>
              </li>
              <li>
                <p>
                          <code class="literal">DB_REP_CONNECTION_RETRY</code>
                    </p>
                <p>
                         Configure the amount of time the Replication
                         Manager will wait before trying to re-establish a
                         connection to another site after a communication
                         failure.  The default wait time is 30 seconds.
                    </p>
              </li>
              <li>
                <p>
                          <code class="literal">DB_REP_ELECTION_TIMEOUT</code>
                     </p>
                <p>
                         The timeout period for an election.  The default
                         timeout is 2 seconds.
                     </p>
              </li>
              <li>
                <p>
                          <code class="literal">DB_REP_ELECTION_RETRY</code>
                    </p>
                <p>
                         Configure the amount of time the Replication
                         Manager will wait before retrying a failed
                         election.  The default wait time is 10 seconds.
                    </p>
              </li>
              <li>
                <p><a id="set_timeout_DB_REP_FULL_ELECTION_TIMEOUT"></a>
                          <code class="literal">DB_REP_FULL_ELECTION_TIMEOUT</code>
                    </p>
                <p>
                         An optional configuration timeout period to wait
                         for full election participation the first time the
                         replication group finds a master. By default this
                         option is turned off and normal election timeouts
                         are used. (See the 
                         <a href="../../programmer_reference/rep_elect.html" class="olink">Elections</a>
                         section in the <em class="citetitle">Berkeley DB Programmer's Reference Guide</em>
                         for more information.)
                    </p>
              </li>
              <li>
                <p>
                          <code class="literal">DB_REP_HEARTBEAT_MONITOR</code>
                    </p>
                <p>
                         The amount of time the Replication Manager,
                         running at a client site, waits for some message
                         activity on the connection from the master
                         (heartbeats or other messages) before concluding
                         that the connection has been lost.  This timeout
                         should be of longer duration than the
                         <code class="literal">DB_REP_HEARTBEAT_SEND</code> timeout
                         to ensure that heartbeats are not missed.  When 0
                         (the default), no monitoring is performed. 
                    </p>
              </li>
              <li>
                <p>
                          <code class="literal">DB_REP_HEARTBEAT_SEND</code>
                    </p>
                <p>
                         The frequency at which the Replication Manager,
                         running at a master site, broadcasts a heartbeat
                         message in an otherwise idle system.  Heartbeat
                         messages are used at client sites to monitor the
                         connection to the master and to help request missing
                         master changes in the absence of master activity.
                         When 0 (the default), no heartbeat messages will be
                         sent.
                    </p>
              </li>
              <li>
                <p>
                          <code class="literal">DB_REP_LEASE_TIMEOUT</code>
                    </p>
                <p>
                         Configure the amount of time a client grants its
                         master lease to a master.  When using master
                         leases all sites in a replication group must use
                         the same lease timeout value.  There is no default
                         value.  If leases are desired, this method must be
                         called prior to calling 
                         <a class="xref" href="repstart.html" title="DB_ENV-&gt;rep_start()">DB_ENV-&gt;rep_start()</a>  method. 
                         See also <a class="xref" href="repclockskew.html" title="DB_ENV-&gt;rep_set_clockskew()">DB_ENV-&gt;rep_set_clockskew()</a> 
                         method, <a class="xref" href="repconfig.html" title="DB_ENV-&gt;rep_set_config()">DB_ENV-&gt;rep_set_config()</a> 
                         method or <a href="../../programmer_reference/rep_lease.html" class="olink">Master leases</a>.
                    </p>
              </li>
            </ul>
          </div>
        </div>
      </div>
      <div class="sect2" lang="en" xml:lang="en">
        <div class="titlepage">
          <div>
            <div>
              <h3 class="title"><a id="idp54210128"></a>Errors</h3>
            </div>
          </div>
        </div>
        <p>
             The <code class="methodname">DB_ENV-&gt;rep_set_timeout()</code> <span>
            <span>
                 method may fail and return one of the following non-zero errors:
            </span>
            
        </span>
        </p>
        <div class="sect3" lang="en" xml:lang="en">
          <div class="titlepage">
            <div>
              <div>
                <h4 class="title"><a id="idp54189080"></a>EINVAL</h4>
              </div>
            </div>
          </div>
          <p>
                If setting the lease timeout and replication has already been started; if
                setting a Replication Manager timeout for a Base API application;
                or if an invalid flag value or parameter was specified.
            </p>
        </div>
      </div>
      <div class="sect2" lang="en" xml:lang="en">
        <div class="titlepage">
          <div>
            <div>
              <h3 class="title"><a id="idp54212896"></a>Class</h3>
            </div>
          </div>
        </div>
        <p>
                <a class="link" href="env.html" title="Chapter 5.  The DB_ENV Handle">DB_ENV</a>  
            </p>
      </div>
      <div class="sect2" lang="en" xml:lang="en">
        <div class="titlepage">
          <div>
            <div>
              <h3 class="title"><a id="idp54204696"></a>See Also</h3>
            </div>
          </div>
        </div>
        <p>
             <a class="xref" href="rep.html#replist" title="Replication and Related Methods">Replication and Related Methods</a> 
        </p>
      </div>
    </div>
    <div class="navfooter">
      <hr />
      <table width="100%" summary="Navigation footer">
        <tr>
          <td width="40%" align="left"><a accesskey="p" href="repset_request.html">Prev</a> </td>
          <td width="20%" align="center">
            <a accesskey="u" href="rep.html">Up</a>
          </td>
          <td width="40%" align="right"> <a accesskey="n" href="reptransport.html">Next</a></td>
        </tr>
        <tr>
          <td width="40%" align="left" valign="top">DB_ENV-&gt;rep_set_request() </td>
          <td width="20%" align="center">
            <a accesskey="h" href="index.html">Home</a>
          </td>
          <td width="40%" align="right" valign="top"> DB_ENV-&gt;rep_set_transport()</td>
        </tr>
      </table>
    </div>
  </body>
</html>
